BeginFrameRequest

data class BeginFrameRequest(frameTimeTicks: Double?, interval: Double?, noDisplayUpdates: Boolean?, screenshot: ScreenshotParams?)
Content copied to clipboard

Represents request frame that can be used with HeadlessExperimental#beginFrame operation call.

Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gl/3zHXhB for more background.

See also

Constructors

BeginFrameRequest
Link copied to clipboard
fun BeginFrameRequest(frameTimeTicks: Double? = null, interval: Double? = null, noDisplayUpdates: Boolean? = null, screenshot: ScreenshotParams? = null)
Content copied to clipboard

Properties

frameTimeTicks
Link copied to clipboard
val frameTimeTicks: Double? = null
Content copied to clipboard
Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime).
interval
Link copied to clipboard
val interval: Double? = null
Content copied to clipboard
The interval between BeginFrames that is reported to the compositor, in milliseconds.
noDisplayUpdates
Link copied to clipboard
val noDisplayUpdates: Boolean? = null
Content copied to clipboard
Whether updates should not be committed and drawn onto the display.
screenshot
Link copied to clipboard
val screenshot: ScreenshotParams? = null
Content copied to clipboard
If set, a screenshot of the frame will be captured and returned in the response.

Sources

jvm source
Link copied to clipboard